Resource URL: /platform/<<version=1>>/snapshot/snapshots/<SID>/locks/<LID>

    Overview: This resource applies the standard collection item pattern to
              individual OneFS snapshot locks.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve lock information.

       URL: GET /platform/<<version=1>>/snapshot/snapshots/<SID>/locks/<LID>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "locks": {
          "items": {
            "type": "object", 
            "properties": {
              "comment": {
                "type": "string", 
                "description": "User supplied lock comment."
              }, 
              "count": {
                "type": "integer", 
                "description": "Recursive lock count."
              }, 
              "expires": {
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "The Unix Epoch time the snapshot lock will expire and be eligible for automatic deletion."
              }, 
              "id": {
                "type": "integer", 
                "description": "System generated lock ID."
              }
            }
          }, 
          "type": "array"
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify lock. All input fields are optional, but one or more must be
            supplied.

       URL: PUT /platform/<<version=1>>/snapshot/snapshots/<SID>/locks/<LID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "expires": {
      "required": false, 
      "minimum": 1, 
      "type": [
        "null", 
        "integer"
      ], 
      "description": "The Unix Epoch time the snapshot lock will expire and be eligible for automatic deletion.", 
      "maximum": 2147483647
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete the snapshot lock.

          URL: DELETE
               /platform/<<version=1>>/snapshot/snapshots/<SID>/locks/<LID>

There are no query arguments for this method.

There is no JSON response body for this method.
